Jamdocs[01]管理sphinx文档利器

摘要

Jamdocs 是全网唯一的管理sphinx文档工具,基于jam.py开发。
sphinx 是优秀的文档写作工具,方便管理文档。
Jamdocs 能够让你在浏览器中编写文档并编译。

项目地址

github: https://github.com/jam-py/jamdocs

安装教程

git clone https://github.com/jam-py/jamdocs.git

运行jamdoc server

cd jamdocs
./server.py 12345
(base) [xxx@centos jamdocs]$ ./server.py 12345

  • Running on http://0.0.0.0:12345/ (Press CTRL+C to quit)
  • 在浏览器中访问jamdoc 服务 http://118.89.150.227:12345/

    第一次使用会弹出对话框,
    要求填写project的名字:随便写一个名字,方便自己知道是哪一个项目的文档即可
    要求填写project的配置文件conf.py位置(以sphinx文件结尾)。
    如图所示:

可以同时添加并管理多个sphinx project.

看到sphinx 文档的结构,具有如下功能

  • 编辑rst文件
  • 添加rst文件
  • 编译rst文件

这样我们就可以在浏览器中编写文档,不需要登陆服务器。

jamdocs 不足之处

  • 不能上传文档

但是jam.py非常灵活,你可以对jamdocs的功能进行自定义就可以实现上传文档的功能。

参考

  1. https://github.com/jam-py/jamdocs